update descriptions for spatial, bbox, coordinates and centroid #207
Conversation
There was a problem hiding this comment.
Edit:
The geographical area covered by the dataset. The use of
bboxis recommended overgeometryorcentroid.
A geographic bounding box defined by two longitudes and two latitudes delimiting the geographical area. Values must be given using the World Geodetic System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units of decimal degrees, e.g. bbox = [51.2867;51.6918;-0.5103;0.3340]
Is there any particular order to give the 4 values? e.g.
bbox = min Longitude , min Latitude , max Longitude , max Latitude?
If so, must be specified here.
One or more GeoJSON positions according to the GeoJSON geometry type defined in
.type. Values must be given using the World Geodetic System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units of decimal degrees."
- Please add example
- Specify a limit to coordinate pairs (e.g. 30 or 50)
|
@matamadio I've added the specification of the order of the 4 values in |
There was a problem hiding this comment.
I would add specific coordinate examples for all fields, just to be safe.
Also specify that coordinates come in "comma separated values" and not semicolon or other symbols.
e.g. bbox = (51.2867,-0.5103,51.6918,0.3340)
e.g. centroid = (51.751944, -1.257778)
e.g. polygon = (...)
I understand that there are no explicit limitations for coordinates number, but again to be safe I would discourage from adding very complex geometries that could result into large files / brake the CoVE tool. Maybe just specify "Please use simplified geometries"?
The problem with doing this is that this is how it should be put in in JSON but in the spreadsheet template it needs to be semi-colon. The spreadsheet template is generated automatically from the JSON schema pulling the field descriptions into the '# description' row. So if we explicitly say to use CSV values here the relevant columns in the spreadsheet will end up with conflicting guidance. But we can fit it somewhere into the guidance documentation so I've added a note to the documentation issue. |
There was a problem hiding this comment.
We may as well make the schema change proposed in #197 (comment) since it is an improvement and it is just a case of copy-pasting.
Co-authored-by: Duncan Dewhurst <[email protected]>
But that thread ends with #197 (comment) where we agreed the only change that needed made was to update the descriptions? But I do agree that tightening up the constraints would be a good thing so I'll add that update in anyway |
Yes, sorry. I meant to include implementing the schema change since it is already worked out! |
Related issues
closes #197 and closes #201
Description
Merge checklist
./manage.pypre-commitIf you added or removed a field:
collapseoption of the jsonschema directives for dataset, resource, hazard, exposure, vulnerability and loss onreference/schema.mdHaving trouble?
See how to resolve check failures.